CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/SQLConnections (Get)
Get/projects/{projectId}/SQLConnections
Description
Gets an array of SQL connections objects that satisfy the query criteria
Parameters
NameDescriptionData Type
the id of the projectstring
filters the list of connections based on the table_idstring
provides a wild card string to filter sql connections by their connection type.(undefined)
200 Response

The response body is of type SQLGetResponse.

The collection of sql connections that satify the query.

Overview

SQLGetResponse
The results of the points get query
SQLDefaultConnections : Array[CimSQLConnection]
An array of the CimSQLConnection objects to create/update.
ConnectionType : CimSQLConnectionType
ODBCDataSource : string
ODBC Data connection.
UserID : string
User who will connect to the selected database driver. A database user name is required if you are connecting to a SQL Server.
Passsword : string
Password needed to connect to the selected database driver. A password is required if you are connecting to a SQL Server.
ReconnectWaitPeriod : integer
The amount of time that the Database Logger waits between reconnect attempts when the connection to the database is lost.
ReconnectWaitUnit : CimTimeUnitEnum
defines units for time values
EnableStoreAndForward : boolean
Choose enable store and forward to enable the ALARM_LOG table perform store and forward options.
MaxNumberOfStoredRecord : number
To select the number of records the Database Logger will store when its connection to the database is down. Enter a number between 1 and 4294967285. 0 indicates no limit.
SQLTableConnections : Array[CimSQLTableConnection]
An array of the CimSQLConnection objects to create/update.
Table_id : string
Table id on which connection is updated.
SQLConnection : CimSQLConnection
Fields that describe the connection to a SQL connection
ConnectionType : CimSQLConnectionType
ODBCDataSource : string
ODBC Data connection.
UserID : string
User who will connect to the selected database driver. A database user name is required if you are connecting to a SQL Server.
Passsword : string
Password needed to connect to the selected database driver. A password is required if you are connecting to a SQL Server.
ReconnectWaitPeriod : integer
The amount of time that the Database Logger waits between reconnect attempts when the connection to the database is lost.
ReconnectWaitUnit : CimTimeUnitEnum
defines units for time values
EnableStoreAndForward : boolean
Choose enable store and forward to enable the ALARM_LOG table perform store and forward options.
MaxNumberOfStoredRecord : number
To select the number of records the Database Logger will store when its connection to the database is down. Enter a number between 1 and 4294967285. 0 indicates no limit.
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
Error if objects not found
This fault returns a response body of type ProblemDetails.
General error
See Also